Skip to main content

dropboxUploadSessionStart

Type

command

Summary

Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB.

Syntax

dropboxUploadSessionStart <pAccessToken>, <pData>, [<pCallback>]

Description

This call starts a new upload session with the given data. You can then use dropboxUploadSessionAppend with the returned session id to add more data and dropboxUploadSessionFinish to save all the data to a file in Dropbox.

note

A single request should not upload more than 150 MB of file contents.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pData

The binary file data

pCallback

The handler to call when the request is complete. If empty the command will block until complete.